Skip to content

update readme for autocompletion when using ipdb with pytest #285

Merged
gotcha merged 1 commit intogotcha:masterfrom
ygorpontelo:master
Feb 27, 2026
Merged

update readme for autocompletion when using ipdb with pytest #285
gotcha merged 1 commit intogotcha:masterfrom
ygorpontelo:master

Conversation

@ygorpontelo
Copy link
Contributor

@ygorpontelo ygorpontelo commented Oct 14, 2024

I was having trouble with autocomplete using just Pdb.

Based on this issue, changing to TerminalPdb fixed the problems. Probably best to update the readme to avoid other users having problems.

Summary by CodeRabbit

  • Documentation
    • Updated pytest configuration examples and documentation snippets to reflect the correct debugger class references for debugging integration.

@gotcha gotcha changed the title update readme update readme for autocmpletion when using ipdb with pytest Nov 28, 2024
@gotcha gotcha changed the title update readme for autocmpletion when using ipdb with pytest update readme for autocompletion when using ipdb with pytest Nov 28, 2024
@gotcha
Copy link
Owner

gotcha commented Feb 27, 2026

@coderabbitai review

@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

Note

Currently processing new changes in this PR. This may take a few minutes, please wait...

📥 Commits

Reviewing files that changed from the base of the PR and between 400e37c and c258b5d.

📒 Files selected for processing (1)
  • README.rst
 _______________________________________________________________________________
< Program close to the problem domain. Design and code in your user's language. >
 -------------------------------------------------------------------------------
  \
   \   (\__/)
       (•ㅅ•)
       /   づ

✏️ Tip: You can disable in-progress messages and the fortune message in your review settings.

Tip

Migrating from UI to YAML configuration.

Use the @coderabbitai configuration command in a PR comment to get a dump of all your UI settings in YAML format. You can then edit this YAML file and upload it to the root of your repository to configure CodeRabbit programmatically.

✨ Finishing Touches
🧪 Generate unit tests (beta)

✅ Unit Test PR creation complete.

  • Create PR with unit tests
  • Commit unit tests in branch master
  • Post copyable unit tests in a comment

Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

Note

Unit test generation is a public access feature. Expect some limitations and changes as we gather feedback and continue to improve it.


Generating unit tests... This may take up to 20 minutes.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@README.rst`:
- Around line 213-220: The README shows TOML-style `[tool.pytest.ini_options]`
in the pytest.ini example; update the pytest.ini code block to use proper INI
syntax by replacing the section header with `[pytest]` and keep the `addopts =
"--pdbcls=IPython.terminal.debugger:TerminalPdb"` line unchanged, while leaving
the `pyproject.toml` example as-is; ensure you edit the pytest.ini example block
(the one containing `addopts`) so it uses `[pytest]` as the section header.

ℹ️ Review info

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 400e37c and c258b5d.

📒 Files selected for processing (1)
  • README.rst

Comment on lines +213 to +220
addopts = "--pdbcls=IPython.terminal.debugger:TerminalPdb"

``pyproject.toml``:

.. code:: yml

[tool.pytest.ini_options]
addopts = "--pdbcls=IPython.terminal.debugger:Pdb"
addopts = "--pdbcls=IPython.terminal.debugger:TerminalPdb"
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🟡 Minor

🧩 Analysis chain

🏁 Script executed:

# First, find and examine README.rst at the specified lines
fd -n "README.rst" -x cat -n {} | sed -n '210,225p'

Repository: gotcha/ipdb

Length of output: 285


🌐 Web query:

pytest.ini syntax configuration section header format

💡 Result:

In a pytest.ini (INI syntax), the pytest configuration must be under the section header:

[pytest]

Example:

[pytest]
addopts = -ra -q
testpaths =
    tests

Related formats (different headers): tox.ini also uses [pytest], while setup.cfg uses [tool:pytest]. [1]

Sources: [1] (docs.pytest.org)

Citations:


🌐 Web query:

pyproject.toml tool.pytest.ini_options configuration format

💡 Result:

In pyproject.toml, pytest supports an INI-style configuration table named:

[tool.pytest.ini_options]

This table is the TOML equivalent of the [pytest] section in pytest.ini: keys are normal pytest INI options (e.g. addopts, testpaths, minversion, markers, filterwarnings, etc.). Example: (docs.pytest.org)

[tool.pytest.ini_options]
minversion = "6.0"
addopts = "-ra -q"
testpaths = ["tests", "integration"]
xfail_strict = true
filterwarnings = ["error"]
markers = [
  "slow: mark slow tests",
]

Notes:

  • Use TOML scalars/arrays as shown (strings, booleans, lists of strings). (docs.pytest.org)
  • Since pytest 9.0, you can alternatively use [tool.pytest] to “leverage native TOML types”; [tool.pytest.ini_options] remains available for the INI-style mapping. (docs.pytest.org)

Citations:


🏁 Script executed:

# Find README.rst and show lines 210-225
find . -name "README.rst" -type f -exec sed -n '210,225p' {} +

Repository: gotcha/ipdb

Length of output: 335


🏁 Script executed:

# Show lines 205-225 to see section context
find . -name "README.rst" -type f -exec sed -n '205,225p' {} +

Repository: gotcha/ipdb

Length of output: 489


Fix pytest.ini example to use correct INI format syntax.

The first code block under pytest.ini (lines 213) incorrectly shows TOML syntax [tool.pytest.ini_options], which belongs only to pyproject.toml. The pytest.ini example should use INI format with the [pytest] section header:

Corrected example
[pytest]
addopts = "--pdbcls=IPython.terminal.debugger:TerminalPdb"

The pyproject.toml example is correct as-is.

🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.

In `@README.rst` around lines 213 - 220, The README shows TOML-style
`[tool.pytest.ini_options]` in the pytest.ini example; update the pytest.ini
code block to use proper INI syntax by replacing the section header with
`[pytest]` and keep the `addopts =
"--pdbcls=IPython.terminal.debugger:TerminalPdb"` line unchanged, while leaving
the `pyproject.toml` example as-is; ensure you edit the pytest.ini example block
(the one containing `addopts`) so it uses `[pytest]` as the section header.

@coderabbitai
Copy link

coderabbitai bot commented Feb 27, 2026

Agent ran but didn't generate any test files. Tests may already exist or changes don't require additional tests.

@gotcha gotcha merged commit 9257233 into gotcha:master Feb 27, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants